<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Agile Led: Agile Led</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Agile Led<span id="projectnumber">&#160;1.1.1</span>
   </div>
   <div id="projectbrief">A agile led package.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- 制作者 Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'搜索','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','搜索');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div><div class="header">
  <div class="headertitle"><div class="title">Agile Led </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md_C__Users_longwei_ma_Desktop_test_packages_agile_led_README"></a> </p>
<h1><a class="anchor" id="autotoc_md12"></a>
1、介绍</h1>
<p >Agile Led 是基于 RT-Thread 实现的 led 软件包，提供 led 操作的 API。</p>
<h2><a class="anchor" id="autotoc_md13"></a>
1.1、特性</h2>
<ol type="1">
<li>代码简洁易懂，充分使用 RT-Thread 提供的 API</li>
<li>详细注释</li>
<li>线程安全</li>
<li>断言保护</li>
<li>API 操作简单</li>
</ol>
<h2><a class="anchor" id="autotoc_md14"></a>
1.2、目录结构</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">名称   </th><th class="markdownTableHeadNone">说明    </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">doc   </td><td class="markdownTableBodyNone">文档目录    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">examples   </td><td class="markdownTableBodyNone">例子目录    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">inc   </td><td class="markdownTableBodyNone">头文件目录    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">src   </td><td class="markdownTableBodyNone">源代码目录   </td></tr>
</table>
<h2><a class="anchor" id="autotoc_md15"></a>
1.3、许可证</h2>
<p >Agile Led package 遵循 LGPLv2.1 许可，详见 <code>LICENSE</code> 文件。</p>
<h2><a class="anchor" id="autotoc_md16"></a>
1.4、依赖</h2>
<ul>
<li>RT-Thread 3.0+</li>
<li>RT-Thread 4.0+</li>
</ul>
<h1><a class="anchor" id="autotoc_md17"></a>
2、如何打开 Agile Led</h1>
<p >使用 Agile Led package 需要在 RT-Thread 的包管理器中选择它，具体路径如下：</p>
<div class="fragment"><div class="line">RT-Thread online packages</div>
<div class="line">    peripheral libraries and drivers ---&gt;</div>
<div class="line">        [*] agile_led: A agile led package</div>
</div><!-- fragment --><p >然后让 RT-Thread 的包管理器自动更新，或者使用 <code>pkgs --update</code> 命令更新包到 BSP 中。</p>
<h1><a class="anchor" id="autotoc_md18"></a>
3、使用 Agile Led</h1>
<ul>
<li>帮助文档请查看 <a href="./doc/doxygen/Agile_Led.chm">doc/doxygen/Agile_Led.chm</a></li>
</ul>
<p >如果未使能 PKG_AGILE_LED_USING_THREAD_AUTO_INIT:</p>
<ol type="1">
<li>agile_led_env_init 初始化环境</li>
<li>创建一个线程，周期调用 agile_led_process，建议周期时间不要太长</li>
</ol>
<ul>
<li>agile_led_create / agile_led_init 创建 / 初始化对象</li>
<li>agile_led_start 启动运行</li>
<li><p class="startli">agile_led_dynamic_change_light_mode / agile_led_static_change_light_mode 更改模式</p>
<p class="startli">该操作也可在启动运行前执行</p>
</li>
<li>如果需要感知对象执行结束，agile_led_set_compelete_callback 设置回调函数</li>
<li>过程中需要强制停止，使用 agile_led_stop</li>
<li>agile_led_on / agile_led_off / agile_led_toggle 单独操作对象</li>
</ul>
<h2><a class="anchor" id="autotoc_md19"></a>
3.1、示例</h2>
<p >使用示例在 <a href="./examples">examples</a> 下。</p>
<h2><a class="anchor" id="autotoc_md20"></a>
3.2、Doxygen 文档生成</h2>
<ul>
<li>使用 <code>Doxywizard</code> 打开 <a href="./doc/doxygen/Doxyfile">Doxyfile</a> 运行，生成的文件在 <a href="./doc/doxygen/output">doxygen/output</a> 下。</li>
<li>需要更改 <code>Graphviz</code> 路径。</li>
<li><code>HTML</code> 生成未使用 <code>chm</code> 格式的，如果使能需要更改 <code>hhc.exe</code> 路径。</li>
</ul>
<h1><a class="anchor" id="autotoc_md21"></a>
4、联系方式 &amp; 感谢</h1>
<ul>
<li>维护：马龙伟</li>
<li>主页：<a href="https://github.com/loogg/agile_led">https://github.com/loogg/agile_led</a></li>
<li>邮箱：<a href="#" onclick="location.href='mai'+'lto:'+'254'+'40'+'472'+'13'+'@qq'+'.c'+'om'; return false;">25440<span style="display: none;">.nosp@m.</span>4721<span style="display: none;">.nosp@m.</span>3@qq.<span style="display: none;">.nosp@m.</span>com</a> </li>
</ul>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">制作者 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
  </ul>
</div>
</body>
</html>
